Collapsing Windows1

The following Window Manager functions for collapsing windows are new with Appearance Manager 1.0:

CollapseWindow

Collapses or expands a window to its title bar .



 
pascal OSStatus CollapseWindow (

                     WindowPtr inWindow,

                     Boolean inCollapseIt);

inWindow: A pointer to a window.
inCollapseIt: A Boolean value indicating whether the window should be collapsed or expanded.
function result: A result code; see Result Codes.

DISCUSSION

The CollapseWindow function tells the Window Manager to collapse or expand a window depending upon the value passed in the inCollapseIt parameter. Only window definition functions that return the feature bit kWindowCanCollapse in response to a kWindowGetFeatures message support this function; see GetWindowFeatures.

VERSION NOTES

Available with Appearance Manager 1.0 and later.

CollapseAllWindows

Collapses or expands all collapsable windows in an application.



 
pascal OSStatus CollapseAllWindows (Boolean inCollapseEm);

inCollapseEm: A Boolean value. Set to true to collapse all windows in the application. Set to false to expand all windows in the application.
function result: A result code; see Result Codes.

DISCUSSION

Only window definition functions that return the feature bit kWindowCanCollapse in response to a kWindowGetFeatures message support the CollapseAllWindows function; see GetWindowFeatures.

VERSION NOTES

Available with Appearance Manager 1.0 and later.

IsWindowCollapsed

Determines whether a window is currently collapsed.



 
pascal Boolean IsWindowCollapsed (WindowPtr inWindow);

inWindow: A pointer to the window to be examined.
function result: A Boolean value. If true , the window is collapsed. If false , the window is expanded.

DISCUSSION

Only window definition functions that return the feature bit kWindowCanCollapse in response to a kWindowGetFeatures message support this function; see GetWindowFeatures. Your window definition function should call IsWindowCollapsed to determine whether or not a window is collapsed, so you can modify its structure and content regions as appropriate. Typically, a window's content region is empty in a collapsed state.

VERSION NOTES

Available with Appearance Manager 1.0 and later.

IsWindowCollapsable

Determines whether a window can be collapsed.



 
pascal Boolean IsWindowCollapsable (WindowPtr inWindow);

inWindow: A pointer to the window to be examined.
function result: A Boolean value. If true , the window can be collapsed; otherwise, false.

DISCUSSION

Your program can call the IsWindowCollapsable function to determine if a given window can be programmatically collapsed by calling the function CollapseWindow. Whether a window is collapsable is determined by whether the window definition function returns the feature bit kWindowCanCollapse in response to a kWindowGetFeatures message.

VERSION NOTES

Available with Appearance Manager 1.0 and later.